Blog - LINE ENGINEERING

TAG ARCHIVES: Technical Writing

「LINE Technical Writing Meetup vol.1」を開催しました！
LINE Engineering2021-04-01
こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。 2021年3月11日(木) に、「LINE Technical Writing Meetup vol.1」をオンラインにて開催しました。テクニカルライティングをテーマにした技術者向けのミートアップは初開催だったため、どの程度みなさんに興味を持ってもらえるかという心配もあったのですが、蓋を開けてみたら600人超の参加申し込みをいただき、当日もQ&Aの時間内では回答しきれないほどの質問をいただいて、大盛況のイベントとなりました。この開催レポートでは、当日の様子を動画や資料でご紹介していきます。 LINE Technical Writing Meetupってなに？セッション1：これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけセッションの概要そもそも「分かりやすい文章」とは？ポイント1：名前を大事にしてほしい話ポイント2：あらかじめ読者との距離を近づけてほしい話動画（0:16:57〜）資料セッション2：分
LINE社内テクニカルライティング講座第3弾！不要な人に社内文書を読ませないコツ
yazakimakoto2020-09-24
こんにちは。Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。LINE社内で大評判のテクニカルライティング講座をブログにまとめてみたシリーズも第3弾になりました。（第1弾、第2弾もぜひ読んでください！）今回の記事では、以下のようにトピックが多く集まったときに「自分が書いたトピックを（その情報が不要な人に）読ませないためのコツ」を説明します。具体的には、順番に気を配ったり、情報の分類を気をつけたり、タイトルを工夫したり、という話をします。 ※図のカード1個が1トピックです。この図ではトピックが6個あります。全部読んでもらおうとしていませんか？おそらくほとんどの人は、ほかの人の文章を読むときに、必要そうな文だけピックアップして読んだり、タイトルだけで内容を判断したつもりになったりすると思います。検索エンジンで検索したときに、表示された内容だけで、文章の内容を推測して読むか読まないか決めますよね。そういう感じです。一方、自分が書いた文章は、ほかの人に1文字も逃さずに読んでもらえることを期待していないでしょうか？みなさ
LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ
yazakimakoto2020-08-21
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。前回の記事を簡単にまとめると「たくさんの文案を書いて、一番良さそうなものを選択することがとても大切です」という話を多くの例文を使って説明しました。まだ読んでいない方はぜひ読んでみてください。今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。ここでは、このくらいの情報量の文章を「トピック」と呼びます。第2弾を最後まで読むと、「トピック」を書くときにどのような点に注意すると、わかりやすくなるかということが理解できます。早速、タイトルの話から始めましょう！タイトルを付けるまず、適切なタイトルを付けることの重要
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
yazakimakoto2020-07-22
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介しています。どれくらい大評判だったかというと、2日間4セッションでしたが、エントリー数はのべ1000人を超え、実際の参加人数はのべ約900人。アンケートの回答は以下のとおり、のべ454人。そして、アンケートに答えてくれた全員が「期待以上に面白かった」または「面白かった」と答えてくれました。正直、「面白くなかった」「期待外れだった」が0だったことに驚きました。 ※ 1
コメントパーサを利用した簡単なAPIドキュメンテーション方法
jeongeun-jeon2020-07-21
先日、日本のテクニカルライター専門チームによる紹介記事が掲載されましたが、韓国にもテクニカルライターは在籍しています。テクニカルライターとしてもっとも楽しい瞬間は、新しいプロジェクトをスタートする時です。プロジェクト開始時点においてはすべてがオープンで自由なため、新奇な領域への探究心が刺激されます。難解な技術を学べる技術文書のコンサルティングは、短期間にせよ、とても刺激的な仕事です。この記事では、数ヶ月前にAPIドキュメントのコンサルティングをするうえで学んだことを紹介します。記事のテーマは、新しいプログラム言語のための、コメントベースのAPIドキュメント生成ツール開発についてです。厳密には、「ツール開発」と言うより「最適なツールを探して利用する」ことなので、難解なコードを期待したり、心配する必要はありません。ソースコード上にコメントで記述したAPIの説明文を、自動で文書化することはありふれた手法です。JavadocやJSDocと言うツールが有名ですが、主要なプログラミング言語であれば、これらのドキュメント生成ツールを利用してドキュメントを作ることができます。どの言語にどのツールを
- Technical Writing
LINEの社内には「テクニカルライティング」の専門チームがあります
LINE Engineering2020-06-17
こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。今日は「テクニカルライター」というお仕事と、LINEにあるテクニカルライティングの専門チームについてお話しします。テクニカルライターという職種がありますテクニカルライターって何をしてるの？何を書くの？ドキュメントはどうやって書いてるの？どんなメンバーで仕事をしてるの？ドキュメントを書く以外にこんなこともしているよでもドキュメントを書くだけだと技術力が下がらない？どんな人がテクニカルライターに向いてるの？テクニカルライターという職種があります私はもともとウェブ制作会社のインフラエンジニアでした。とある技術書を書いたことをきっかけに「テクニカルライターとして一緒に働きませんか？」と声をかけてもらい、LINEへ転職するに至ったのですが、実はお誘いをいただくまで、テクニカルライターという職種があること LINEにはテクニカルライティング専門のチームがあることのどちらも知りませんでした。みなさんは知っていましたか？「ちゃんとドキュメ
ドキュメントエンジニアリングとAPIドキュメンテーション
jeongeun-jeon2019-08-28
はじめにテクニカルライター（technical writer）という言葉を聞くと、ほとんど「ライター」という単語だけ見て「文章を書く人」と思いがちです。もちろん間違いではありません。しかし、実際にキーボードを叩いて文章を書く仕事は、テクニカルライター業務のほんの一部です。1日にどれくらい文章を書くか測定したことはないですが、テクニカルライターのトム・ジョンソン（Tom Johnson）によると、仕事をする時間の約10%が文章を書く時間だそうです。では、その他の時間には何をしているのでしょうか。これもトム・ジョンソンによると、開発者のインタビュー、ほかの人が書いたドキュメントのレビュー、アプリの動作を録画するためにiPhoneの「脱獄」をする、MediaWikiにリンクされている画像にキャプションを入れる方法を探す、などの作業をしているそうです。その中で、私がここで説明したい内容は「iPhoneの脱獄」ではありません。結果的に、文章を書くこととは全く関係なさそうに見えるエンジニアリングについてです。テクニカルライティングの作業をしていると、1回以上は下記のような依頼があります。「技術情報
- Technical Writing
Technical Communication Symposium 2018参加レポート - 技術文書の翻訳品質評価方法
Jihyun2019-02-25
LINE GAME PLATFORMのドキュメントを担当するテクニカルライターです。
こんにちは。LINE GAME PLATFORMのドキュメント作成および配布を担当している、テクニカルライターのJihyun Kimです。LINE GAME PLATFORMは、韓国・日本の両拠点で企画・開発が行われているプロジェクトで、開発ガイドなどのドキュメントも韓国語と日本語の2か国語で作成しています。2か国語で文章を書いて行くうえで最も悩ましいことは、言語によって異なる読者の地域的・文化的背景を文章に溶け込ませることです。私は、小さい頃日本に住んだことがあり、日本語の文章を書くことには慣れていますが、やはり母語が韓国語で、現在働いている地域も韓国ということで、日本現地の独特のニュアンスや臨場感を表現することには、力不足を感じることがあります。そこで、私なりに足りないところを補おうと、日本で開かれるカンファレンスに参加しています。昨年はTC(Technical Communication) Symposium 2018 in Tokyoに参加しました。テクニカルコミュニケーター（Technical Communicators、以下TC）とは、技術文書を作成するテクニ
- Event Report
- Technical Writing
Write the Docs Prague 2018 Recap
Jeongil Kang2018-11-08
LINE技術ドキュメントの作成・管理を担当しているテクニカルライターのJeongil Kangです。
こんにちは。CLOVA技術ドキュメントの作成・管理を担当しているTechnical WritingチームのJeongil Kangです。私がテクニカルライティング(Technical writing)分野に携わってから、もう10年くらいになります。しかし、この記事をお読みの方の中には、テクニカルライティングという言葉を初めて聞くか、聞いたことがあっても果たしてどのような仕事なのかピンとこない、という方も多くいらっしゃるかも知れません。韓国でも、大学にテクニカルライティング関連学科がないからか、この分野に携わる方はなかなか見当たらないのが現状です。特に韓国ではソフトウェア産業の特性から、設計ドキュメント、APIレファレンスといった技術ドキュメントを扱うテクニカルライターに出会うというのはなかなか難しいことです。こうした厳しい環境においてテクニカルライターの多くは、業界の最新ニュースや仕事に関わる知識、戦略を手に入れるためにネット検索かチームメンバー同士の情報・経験の共有に頼っています。ところが今回のWrite the Docsカンファレンス参加で、普段抱えていたそうしたニーズもだ
- Technical Writing
API the Docs参加レポート
Serizawa2018-05-16
LINEプラットフォームの開発者向けドキュメントを担当しているテクニカルライターです。
はじめにこんにちは。テクニカルライターのSerizawaです。LINEには、エンジニアが最新の技術動向を把握できるよう、海外で開催されるカンファレンスに会社負担で参加できる制度があります。今回の記事では、その制度を利用して参加してきたAPIドキュメンテーションのカンファレンス「API the Docs」の様子をご報告します。 API the Docsは、テクニカルライター、API開発者、プロダクトオーナー、エバンジェリスト向けに年に数回世界各地で開催されている、APIドキュメンテーションに特化したイベントです。デベロッパーエクスペリエンスの重要な要素であるドキュメンテーションについて、最新のベストプラクティスやトレンドについて知見を共有し、意見を交換する場になっています。今回のAPI the Docsは、今年4月24日、パリ市内の中心部にあるMozillaオフィスで開催されました。APIエキスパート、コンテンツストラテジスト、ソフトウェア開発者など、異なる立場からAPIドキュメントや開発者ポータルの開発・運営に携わる方々により、10件の講演が行われました。講演内容は、「開発者向けポ
- Technical Writing

1 2